/*
 *      Copyright 2001-2004 Fraunhofer Gesellschaft, Munich, Germany, for its 
 *      Fraunhofer Institute Computer Architecture and Software Technology
 *      (FIRST), Berlin, Germany
 *      
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */


package org.radeox.regex;

/*
 * Called with a MatchResult which is substituted
 *
 * @author stephan
 * @team sonicteam
 * @version $Id: Substitution.java 11 2008-03-02 05:47:42Z iamkeke $
 */

public interface Substitution {
  /**
   * When substituting matches in a matcher, the handleMatch method
   * of the supplied substitution is called with a MatchResult.
   * This method then does something with the match and replaces
   * the match with some output, like replace all 2*2 with (2*2 =) 4.
   *
   * @param buffer StringBuffer to append the output to
   * @param result MatchResult with the match
   */
    public void handleMatch(StringBuffer buffer, MatchResult result);
}